server: control honouring internal IDs by old APIs by shwstppr · Pull Request #11976 · apache/cloudstack

shwstppr · 2025-11-04T12:27:12Z

Description

Fixes #9684

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
Build/CI
Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Fixes apache#9684 Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

codecov · 2025-11-04T12:35:57Z

Codecov Report

❌ Patch coverage is 57.14286% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 19.47%. Comparing base (bfc4f60) to head (a6fe49e).
⚠️ Report is 729 commits behind head on main.

Files with missing lines	Patch %	Lines
server/src/main/java/com/cloud/api/ApiServer.java	66.66%	2 Missing ⚠️
...ava/com/cloud/api/dispatch/ParamProcessWorker.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #11976      +/-   ##
============================================
+ Coverage     17.56%   19.47%   +1.90%     
- Complexity    15540    19360    +3820     
============================================
  Files          5909     6301     +392     
  Lines        529045   568776   +39731     
  Branches      64615    69669    +5054     
============================================
+ Hits          92933   110751   +17818     
- Misses       425657   445948   +20291     
- Partials      10455    12077    +1622

Flag	Coverage Δ
uitests	`3.42% <ø> (-0.17%)`	⬇️
unittests	`20.74% <57.14%> (+2.10%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

DaanHoogland

clgtm (as said on the issue, we can expand on it but good as is)

shwstppr · 2026-01-30T09:10:17Z

@blueorangutan package

blueorangutan · 2026-01-30T09:12:04Z

@shwstppr a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-01-30T10:01:21Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 16647

DaanHoogland · 2026-01-30T10:17:35Z

@nvazquez can you check/review?

shwstppr · 2026-01-31T19:06:36Z

@blueorangutan test

blueorangutan · 2026-01-31T19:08:03Z

@shwstppr a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2026-02-01T11:21:17Z

[SF] Trillian test result (tid-15345)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 55576 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11976-t15345-kvm-ol8.zip
Smoke tests completed. 146 look OK, 4 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_08_arping_in_ssvm	`Failure`	5.20	test_diagnostics.py
ContextSuite context=TestListIdsParams>:teardown	`Error`	1.14	test_list_ids_parameter.py
test_01_snapshot_root_disk	`Error`	4.84	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	49.63	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	49.63	test_snapshots.py
ContextSuite context=TestSnapshotStandaloneBackup>:teardown	`Error`	32.50	test_snapshots.py
test_01_snapshot_usage	`Error`	25.76	test_usage.py
test_01_vpn_usage	`Error`	1.09	test_usage.py

Copilot

Pull request overview

Adds a global configuration switch to control whether legacy (pre-3.x) APIs may still accept internal database IDs for UUID-typed parameters, enabling stricter UUID-only enforcement to address issue #9684.

Changes:

Introduces a new global config key api.disallow.internal.ids in ApiServer.
Applies the config in ParamProcessWorker.translateUuidToInternalId to prevent fallback parsing of numeric/internal IDs when disallowed.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
`server/src/main/java/com/cloud/api/dispatch/ParamProcessWorker.java`	Gates “pre-3.x internal ID fallback” logic on a new global config flag.
`server/src/main/java/com/cloud/api/ApiServer.java`	Adds and registers the `api.disallow.internal.ids` configuration key.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+    public static final ConfigKey<Boolean> ApiDisallowInternalIds = new ConfigKey<>(
+            ConfigKey.CATEGORY_ADVANCED,
+            Boolean.class,
+            "api.disallow.internal.ids",
+            "true",
+            "When enabled, APIs will not honour requests containing internal database IDs. "
+                    + "Only UUIDs will be accepted as entity identifiers. "
+                    + "By default, internal IDs are still accepted for backward compatibility with pre-3.x APIs.",
+            true,
+            ConfigKey.Scope.Global
+    );


        // If annotation's empty, the cmd existed before 3.x try conversion to long
-        final boolean isPre3x = annotation.since().isEmpty();
+        final boolean isPre3x = annotation.since().isEmpty() && !ApiServer.ApiDisallowInternalIds.value();


        Long internalId = null;
        // If annotation's empty, the cmd existed before 3.x try conversion to long
-        final boolean isPre3x = annotation.since().isEmpty();
+        final boolean isPre3x = annotation.since().isEmpty() && !ApiServer.ApiDisallowInternalIds.value();


Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

        Long internalId = null;
        // If annotation's empty, the cmd existed before 3.x try conversion to long
-        final boolean isPre3x = annotation.since().isEmpty();
+        final boolean isPre3x = annotation.since().isEmpty() && !ApiServer.ApiDisallowInternalIds.value();


        Long internalId = null;
        // If annotation's empty, the cmd existed before 3.x try conversion to long
-        final boolean isPre3x = annotation.since().isEmpty();
+        final boolean isPre3x = annotation.since().isEmpty() && !ApiServer.ApiDisallowInternalIds.value();


+            "When enabled, APIs will not honour requests containing internal database IDs. "
+                    + "Only UUIDs will be accepted as entity identifiers. "
+                    + "By default, internal IDs are not accepted even for pre-3.x APIs.",


server: control honouring internal IDs by old APIs

77edb37

Fixes apache#9684 Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

DaanHoogland approved these changes Nov 4, 2025

View reviewed changes

shwstppr marked this pull request as ready for review November 6, 2025 09:11

DaanHoogland added this to the 4.23.0 milestone Jan 30, 2026

DaanHoogland requested a review from nvazquez January 30, 2026 10:17

winterhazel added the status:needs-testing label Mar 17, 2026

weizhouapache modified the milestones: 4.23.0, 4.24.0 Jul 1, 2026

shwstppr commented Jul 13, 2026

View reviewed changes

Comment thread server/src/main/java/com/cloud/api/ApiServer.java Outdated

Apply suggestion from @shwstppr

578681d

Copilot AI review requested due to automatic review settings July 13, 2026 07:04

Copilot started reviewing on behalf of shwstppr July 13, 2026 07:04 View session

shwstppr commented Jul 13, 2026

View reviewed changes

Comment thread server/src/main/java/com/cloud/api/ApiServer.java Outdated

Apply suggestion from @shwstppr

a6fe49e

Copilot AI reviewed Jul 13, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings July 13, 2026 07:07

Copilot started reviewing on behalf of shwstppr July 13, 2026 07:10 View session

Copilot AI reviewed Jul 13, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

server: control honouring internal IDs by old APIs#11976

server: control honouring internal IDs by old APIs#11976
shwstppr wants to merge 3 commits into
apache:mainfrom
shapeblue:controluse-api-internalids

shwstppr commented Nov 4, 2025

Uh oh!

codecov Bot commented Nov 4, 2025 •

edited

Loading

Uh oh!

DaanHoogland left a comment

Uh oh!

shwstppr commented Jan 30, 2026

Uh oh!

blueorangutan commented Jan 30, 2026

Uh oh!

blueorangutan commented Jan 30, 2026

Uh oh!

DaanHoogland commented Jan 30, 2026

Uh oh!

shwstppr commented Jan 31, 2026

Uh oh!

blueorangutan commented Jan 31, 2026

Uh oh!

blueorangutan commented Feb 1, 2026

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

shwstppr commented Nov 4, 2025

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov Bot commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

shwstppr commented Jan 30, 2026

Uh oh!

blueorangutan commented Jan 30, 2026

Uh oh!

blueorangutan commented Jan 30, 2026

Uh oh!

DaanHoogland commented Jan 30, 2026

Uh oh!

shwstppr commented Jan 31, 2026

Uh oh!

blueorangutan commented Jan 31, 2026

Uh oh!

blueorangutan commented Feb 1, 2026

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov Bot commented Nov 4, 2025 •

edited

Loading